<!doctype html>
<html lang="zh-CN">
<head>
  <base href="https://www.nodeapp.cn/documentation.html" />
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width">
  <title>关于本文档 | Node.js 中文文档 | Node.js 中文网</title>
  <meta name="description" content="Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境。Node.js 使用了一个事件驱动、非阻塞式 I/O 的模型，使其轻量又高效。Node.js 的包管理器 npm，是全球最大的开源库生态系统。">
  <link rel="stylesheet" href="assets/style.css">
  <link rel="stylesheet" href="assets/sh.css">
  <link rel="canonical" href="https://www.nodeapp.cn/documentation.html">
  <link rel="apple-touch-icon" href="apple-touch-icon.png">
  <link rel="icon" sizes="32x32" type="image/png" href="favicon.png">
  
  <script>
var _hmt = _hmt || [];
(function() {
  var hm = document.createElement("script");
  hm.src = "https://hm.baidu.com/hm.js?acdf78480f7f8f2b23b812565a5868e0";
  var s = document.getElementsByTagName("script")[0]; 
  s.parentNode.insertBefore(hm, s);
})();
</script>

</head>
<body class="alt apidoc" id="api-section-documentation">
  <div id="content" class="clearfix">
    <div id="column1" data-id="documentation" class="interior">
      <header>
        <h1>Node.js v8.x 中文文档</h1>
        <hr>
      </header>

      <div id="toc">
        <h2>目录</h2>
        <ul>
<li><span class="stability_undefined"><a href="#documentation_about_this_documentation">关于本文档</a></span><ul>
<li><span class="stability_undefined"><a href="#documentation_contributing">Contributing</a></span></li>
<li><span class="stability_undefined"><a href="#documentation_stability_index">稳定性指数</a></span></li>
<li><span class="stability_1"><a href="#documentation_json_output">JSON 输出</a></span></li>
<li><span class="stability_undefined"><a href="#documentation_syscalls_and_man_pages">系统调用与帮助文档</a></span></li>
</ul>
</li>
</ul>

      </div>
<div id="apicontent">
        <h1>关于本文档<span><a class="mark" href="#documentation_about_this_documentation" id="documentation_about_this_documentation">#</a></span></h1>
<!--introduced_in=v0.10.0-->
<!-- type=misc -->
<p>本文档的目的是为了全面地讲解 Node.js 的 API，包括使用方法与相关概念。
每个章节分别介绍一个内置模块或高级概念。</p>
<p>每个主题的标题下会列出属性的类型、方法的参数、以及事件处理回调函数的参数等。</p>
<h2>Contributing<span><a class="mark" href="#documentation_contributing" id="documentation_contributing">#</a></span></h2>
<p>If errors are found in this documentation, please <a href="https://github.com/nodejs/node/issues/new">submit an issue</a>
or see <a href="https://github.com/nodejs/node/blob/master/CONTRIBUTING.md">the contributing guide</a> for directions on how to submit a patch.</p>
<p>Every file is generated based on the corresponding <code>.md</code> file in the
<code>doc/api/</code> folder in Node.js&apos;s source tree. The documentation is generated
using the <code>tools/doc/generate.js</code> program. An HTML template is located at
<code>doc/template.html</code>.</p>
<h2>稳定性指数<span><a class="mark" href="#documentation_stability_index" id="documentation_stability_index">#</a></span></h2>
<!--type=misc-->
<p>文档中每个章节都有稳定性标志。
Node.js 的 API 仍会有少量变化，但随着发展，API 会越来越稳定可靠。
有些 API 久经验证、且被大量依赖，它们几乎不会再变化。
也有些 API 是新增的、或试验的、或被认定为有风险且正在被重新设计中的。</p>
<p>稳定性指数如下：</p>
<div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">稳定性: 0</a> - 废弃的 该特性被认定为存在问题，且可能会计划修改。 不要依赖该特性。 使用该特性可能会产生警告信息。 该特性不会做向后兼容。</div><div class="api_stability api_stability_1"><a href="documentation.html#documentation_stability_index">稳定性: 1</a> - 试验的 该特性仍处于开发中，且未来改变时不做向后兼容，甚至可能被移除。 不建议在生产环境中使用该特性。</div><div class="api_stability api_stability_2"><a href="documentation.html#documentation_stability_index">稳定性: 2</a> - 稳定的 该特性已被证明是符合要求的。 与 npm 生态系统的兼容性是最高优先级，除非有必要否则不会变化。</div><h2>JSON 输出<span><a class="mark" href="#documentation_json_output" id="documentation_json_output">#</a></span></h2>
<div class="api_stability api_stability_1"><a href="documentation.html#documentation_stability_index">稳定性: 1</a> - 试验的</div><p>这个特性是 Node.js v0.6.12 新增的。
该特性是试验的。</p>
<h2>系统调用与帮助文档<span><a class="mark" href="#documentation_syscalls_and_man_pages" id="documentation_syscalls_and_man_pages">#</a></span></h2>
<p>系统调用定义了用户程序和底层操作系统之间的接口，例如 <a href="http://man7.org/linux/man-pages/man2/open.2.html">open(2)</a>、 <a href="http://man7.org/linux/man-pages/man2/read.2.html">read(2)</a>。
Node 函数只是简单地封装了系统调用，例如 <a href="fs.html#fs_fs_open_path_flags_mode_callback"><code>fs.open()</code></a>。
相应的帮助文档会描述系统调用是如何工作的。</p>
<p>有些系统调用是 BSD 系统特有的，例如 <a href="http://man7.org/linux/man-pages/man2/lchown.2.html">lchown(2)</a>。
这意味着 <a href="fs.html#fs_fs_lchown_path_uid_gid_callback"><code>fs.lchown()</code></a> 只适用于 macOS 和其他 BSD 衍生系统，在 Linux 上不可用。</p>
<p>大部分 Unix 系统调用都有对应的 Windows 版本，但 Windows 版本运行起来可能与 Linux 和 macOS 的有些差异。
有些 Unix 系统调用无法在 Windows 中找到对应的操作语义，详见<a href="https://github.com/nodejs/node/issues/4760">议题4760</a>。</p>

      </div>
    </div>

    <div id="column2" class="interior">
      <div id="intro" class="interior">
        <a href="/" title="Go back to the home page">
          Node.js 中文文档 | Node.js 中文网
        </a>
      </div>
      
        <!-- [start-include:_toc.md] -->
<ul>
<li><a href="documentation.html">关于本文档</a></li>
<li><a href="synopsis.html">用法与例子</a></li>
</ul>
<div class="line"></div>

<ul>
<li><a href="assert.html">断言测试</a></li>
<li><a href="async_hooks.html">异步钩子（Async Hooks）</a></li>
<li><a href="buffer.html">缓存（Buffer）</a></li>
<li><a href="addons.html">C++ 插件</a></li>
<li><a href="n-api.html">C/C++ 插件 - N-API</a></li>
<li><a href="child_process.html">子进程</a></li>
<li><a href="cluster.html">集群（Cluster）</a></li>
<li><a href="cli.html">命令行参数</a></li>
<li><a href="console.html">控制台（Console）</a></li>
<li><a href="crypto.html">加密（Crypto）</a></li>
<li><a href="debugger.html">调试器</a></li>
<li><a href="deprecations.html">废弃的 API</a></li>
<li><a href="dns.html">DNS</a></li>
<li><a href="domain.html">域（Domain）</a></li>
<li><a href="esm.html">ECMAScript 模块</a></li>
<li><a href="errors.html">错误（Errors）</a></li>
<li><a href="events.html">事件（Events）</a></li>
<li><a href="fs.html">文件系统</a></li>
<li><a href="globals.html">全局对象（Globals）</a></li>
<li><a href="http.html">HTTP</a></li>
<li><a href="http2.html">HTTP/2</a></li>
<li><a href="https.html">HTTPS</a></li>
<li><a href="inspector.html">检查工具（Inspector）</a></li>
<li><a href="intl.html">国际化</a></li>
<li><a href="modules.html">模块（Modules）</a></li>
<li><a href="net.html">网络（Net）</a></li>
<li><a href="os.html">操作系统（OS）</a></li>
<li><a href="path.html">路径（Path）</a></li>
<li><a href="perf_hooks.html">性能钩子（Performance Hooks）</a></li>
<li><a href="process.html">进程</a></li>
<li><a href="punycode.html">Punycode</a></li>
<li><a href="querystring.html">查询字符串</a></li>
<li><a href="readline.html">逐行读取</a></li>
<li><a href="repl.html">交互式解释器（REPL）</a></li>
<li><a href="stream.html">流（Stream）</a></li>
<li><a href="string_decoder.html">字符串解码</a></li>
<li><a href="timers.html">定时器（Timers）</a></li>
<li><a href="tls.html">安全传输层（TLS/SSL）</a></li>
<li><a href="tracing.html">事件跟踪（Tracing）</a></li>
<li><a href="tty.html">TTY</a></li>
<li><a href="dgram.html">UDP / 数据报</a></li>
<li><a href="url.html">URL</a></li>
<li><a href="util.html">工具集</a></li>
<li><a href="v8.html">V8</a></li>
<li><a href="vm.html">虚拟机（VM）</a></li>
<li><a href="zlib.html">压缩（ZLIB）</a></li>
</ul>
<div class="line"></div>

<ul>
<li><a href="https://github.com/nodejs/node">GitHub 仓库和问题跟踪</a></li>
<li><a href="https://groups.google.com/group/nodejs">邮件列表</a></li>
</ul>
<!-- [end-include:_toc.md] -->

      
    </div>
  </div>
  <script src="assets/sh_main.js"></script>
  <script src="assets/sh_javascript.min.js"></script>
  <script>highlight(undefined, undefined, 'pre');</script>
</body>
</html>
